API

Base APIs

POST base/formula-definitions/{formulaDefinitionId}/calculations

Calculates the given formula with the input provided by the user, returns the calculation result

HTTP method POST
URI https://api.rambase.net/base/formula-definitions/{formulaDefinitionId}/calculations
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {formulaDefinitionId} Formula identifier
Integer, minimum 100000
Successful HTTP status code 200
API resource identifier 2520, version 2

The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.

Format:
1
<FormulaCalculation
FormulaCalculation

This field is optional.

>
2
     <Parameters
Parameters

This field is optional.

>
3
          <Parameter
Parameter

This field is optional.

>
4
               <Key
Key

Key that is used in formula and replaced with the value of the parameter

This field is optional.

>{String}</Key>
5
               <Value
Value

Formula parameter input value

This field is optional.

>{String}</Value>
6
          </Parameter>
7
     </Parameters>
8
</FormulaCalculation>
1
{
2
     "formulaCalculation
FormulaCalculation

This field is optional.

": {
3
          "parameters
Parameters

This field is optional.

": [
4
               {
5
                    "key
Key

Key that is used in formula and replaced with the value of the parameter

This field is optional.

": "{String}",
6
                    "value
Value

Formula parameter input value

This field is optional.

": "{String}"
7
               }
8
          ]
9
     }
10
}

The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.

$access_token String, optional After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time.
$db String, optional Set the database/company for the request
$useMinimumVersion Integer, optional Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information.
$lang String, optional Specifies the language used in the response, following the 3-letter ISO-639-1 [lll]

Read more about filters and sorting on how to use filter parameters and named filters.

Read more about filters and sorting on how to use sortable parameters

Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:
1
<FormulaCalculation>
2
     <Result
Result

Result of the calculated formula

>{Decimal}</Result>
3
</FormulaCalculation>
1
{
2
     "formulaCalculation": {
3
          "result
Result

Result of the calculated formula

": "{Decimal}"
4
     }
5
}

List of available operations/actions for this resource.
See the operations documentation for more information about API operations.

Possible error codes the response might return:

Error 102696 HTTP 404 Formula definition not found
Error 102704 HTTP 404 Formula parameter was not found
Error 102746 HTTP 400 The parameter value can not be more than {0}
Error 102747 HTTP 400 Error in formula: {0}